TestEnvironmentConfiguration.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.configuration;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import junit.framework.TestCase;

/**
 * Test class for EnvironmentConfiguration.
 *
 * @author Oliver Heger
 * @version $Id: TestEnvironmentConfiguration.java 587636 2007-10-23 20:03:47Z oheger $
 */
public class TestEnvironmentConfiguration extends TestCase
{
    /** Stores the configuration to be tested. */
    private EnvironmentConfiguration config;

    protected void setUp() throws Exception
    {
        super.setUp();
        config = new EnvironmentConfiguration();
    }

    /**
     * Helper method for checking that the configuration contains some
     * environment properties. (We expect that at least some properties are set
     * in each environment.)
     */
    private void checkProperties()
    {
        boolean found = false;
        assertFalse("No properties found", config.isEmpty());
        for (Iterator it = config.getKeys(); it.hasNext();)
        {
            String key = (String) it.next();
            assertTrue("Key not found: " + key, config.containsKey(key));
            assertNotNull("No value for property " + key, config.getString(key));
            found = true;
        }
        assertTrue("No property keys returned", found);
    }

    /**
     * Tests whether a newly created configuration contains some properties. (We
     * expect that at least some properties are set in each environment.)
     */
    public void testInit()
    {
        checkProperties();
    }

    /**
     * Tests extracting properties for JDK before 1.5. This method should work
     * on later JDKs, too, so we can test it always.
     */
    public void testExtractProperties14()
    {
        config.extractProperties14();
        checkProperties();
    }

    /**
     * Tests whether a collection with properties is correctly processed.
     */
    public void testExtractPropertiesFromCollection()
    {
        final int count = 8;
        final String prop = "property";
        final String value = "value";

        Collection env = new ArrayList(count);
        for (int i = 0; i < count; i++)
        {
            env.add(prop + i + "=" + value + i);
        }
        env.add("irregularProperty");
        config.extractPropertiesFromCollection(env);

        Map props = new HashMap();
        for (Iterator it = config.getKeys(); it.hasNext();)
        {
            String key = (String) it.next();
            props.put(key, config.getString(key));
        }
        assertEquals("Wrong number of properties", count, props.size());
        for (int i = 0; i < count; i++)
        {
            assertEquals("Wrong value for property " + i, value + i, props
                    .get(prop + i));
        }
        assertFalse("Irregular property found", config
                .containsKey("irregularProperty"));
    }

    /**
     * Tests removing properties. This should not be possible.
     */
    public void testClearProperty()
    {
        String key = (String) config.getKeys().next();
        try
        {
            config.clearProperty(key);
            fail("Could remove a property!");
        }
        catch (UnsupportedOperationException uoex)
        {
            // ok
        }
    }

    /**
     * Tests removing all properties. This should not be possible.
     */
    public void testClear()
    {
        try
        {
            config.clear();
            fail("Could remove properties!");
        }
        catch (UnsupportedOperationException uoex)
        {
            // ok
        }
    }

    /**
     * Tries to add another property. This should cause an exception.
     */
    public void testAddProperty()
    {
        try
        {
            config.addProperty("JAVA_HOME", "C:\\java");
            fail("Could add a property!");
        }
        catch (UnsupportedOperationException uoex)
        {
            // ok
        }
    }

    /**
     * Tries to set the value of a property. This should cause an exception.
     */
    public void testSetProperty()
    {
        try
        {
            config.setProperty("JAVA_HOME", "C:\\java");
            fail("Could set a property!");
        }
        catch (UnsupportedOperationException uoex)
        {
            // ok
        }
    }
}